Add client user guide for smithy java#2522

Merged

hpmellema merged 18 commits intosmithy-lang:mainfrom

hpmellema:add-client-guide-java

Feb 19, 2025

Contributor

hpmellema commented Feb 14, 2025 •

edited

Loading

Background

Adds Client user guide documentation for Smithy Java

Download Artifact

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.


          Add client user guide for smithy java

dd2cc72

hpmellema requested a review from a team as a code owner

February 14, 2025 20:18

hpmellema requested a review from haydenbaker

February 14, 2025 20:18

haydenbaker reviewed

View reviewed changes

docs/source-2.0/java/client/codegen-integrations.rst Outdated Show resolved Hide resolved

haydenbaker reviewed

View reviewed changes

docs/source-2.0/java/client/codegen-integrations.rst Outdated Show resolved Hide resolved

haydenbaker reviewed

View reviewed changes

docs/source-2.0/java/client/codegen-integrations.rst Outdated Show resolved Hide resolved

haydenbaker reviewed

View reviewed changes

docs/source-2.0/java/client/configuration.rst Outdated Show resolved Hide resolved

haydenbaker reviewed

View reviewed changes

docs/source-2.0/java/client/configuration.rst Outdated Show resolved Hide resolved

haydenbaker reviewed

View reviewed changes

docs/source-2.0/java/client/configuration.rst Outdated Show resolved Hide resolved

haydenbaker reviewed

View reviewed changes

docs/source-2.0/java/client/configuration.rst Outdated Show resolved Hide resolved

haydenbaker reviewed

View reviewed changes

docs/source-2.0/java/client/configuration.rst Outdated Show resolved Hide resolved

haydenbaker reviewed

View reviewed changes

docs/source-2.0/java/client/configuration.rst Outdated Show resolved Hide resolved


          Apply suggestions from code review

ec51713

Co-authored-by: Hayden Baker <haydenbaker98@gmail.com>

haydenbaker reviewed

View reviewed changes

docs/source-2.0/java/client/configuration.rst Outdated Show resolved Hide resolved

kstich previously requested changes

View reviewed changes

Contributor

kstich left a comment

A few general comments:

Check line wrapping, there are many very long lines.
Check capitalization of names, Java, Smithy, etc.
Titles should only have a first capital letter "Like this heading" not "Like This Heading".

docs/source-2.0/java/client/codegen-integrations.rst Outdated Show resolved Hide resolved

docs/source-2.0/java/client/codegen-integrations.rst Outdated Show resolved Hide resolved

docs/source-2.0/java/client/customization.rst Outdated Show resolved Hide resolved

docs/source-2.0/java/client/customization.rst Outdated Show resolved Hide resolved

docs/source-2.0/java/client/customization.rst Outdated Show resolved Hide resolved

docs/source-2.0/java/client/configuration.rst Show resolved Hide resolved

docs/source-2.0/java/client/configuration.rst Outdated Show resolved Hide resolved

docs/source-2.0/java/client/configuration.rst Show resolved Hide resolved

docs/source-2.0/java/client/configuration.rst Outdated Show resolved Hide resolved

docs/source-2.0/java/client/configuration.rst Outdated Show resolved Hide resolved

hpmellema and others added 3 commits

February 14, 2025 15:50


          Apply suggestions from code review

8dc4b8a

Co-authored-by: Kevin Stich <kevin@kstich.com>


          Update docs/source-2.0/java/client/configuration.rst

1020b41

Co-authored-by: Hayden Baker <haydenbaker98@gmail.com>


          Apply suggestions from code review

39700ca

Co-authored-by: Kevin Stich <kevin@kstich.com>

haydenbaker reviewed

View reviewed changes

docs/source-2.0/java/client/configuration.rst Outdated Show resolved Hide resolved

docs/source-2.0/java/client/configuration.rst Outdated Show resolved Hide resolved

docs/source-2.0/java/client/configuration.rst Outdated Show resolved Hide resolved

docs/source-2.0/java/client/configuration.rst Outdated Show resolved Hide resolved

docs/source-2.0/java/client/configuration.rst Outdated Show resolved Hide resolved

docs/source-2.0/java/client/configuration.rst Outdated Show resolved Hide resolved

docs/source-2.0/java/client/configuration.rst Outdated Show resolved Hide resolved

docs/source-2.0/java/client/configuration.rst Outdated Show resolved Hide resolved

docs/source-2.0/java/client/configuration.rst Outdated Show resolved Hide resolved

docs/source-2.0/java/client/configuration.rst Outdated Show resolved Hide resolved

hpmellema and others added 6 commits

February 14, 2025 16:12


          Update based on PR feedback

911b44a


          Capitalization fixes

11d1ca0


          Additional updates based on feedback

d84cccd


          Apply suggestions from code review

3c3f2e8

Co-authored-by: Hayden Baker <haydenbaker98@gmail.com>


          Even more fixes

9c179ac


          Fix bad indent

ebbe788

haydenbaker reviewed

View reviewed changes

docs/source-2.0/java/client/configuration.rst Outdated Show resolved Hide resolved

haydenbaker reviewed

View reviewed changes

docs/source-2.0/java/client/configuration.rst Outdated Show resolved Hide resolved

haydenbaker reviewed

View reviewed changes

docs/source-2.0/java/client/customization.rst Outdated Show resolved Hide resolved

haydenbaker reviewed

View reviewed changes

docs/source-2.0/java/client/customization.rst Outdated Show resolved Hide resolved

haydenbaker reviewed

View reviewed changes

docs/source-2.0/java/client/customization.rst Outdated Show resolved Hide resolved

haydenbaker reviewed

View reviewed changes

docs/source-2.0/java/client/dynamic-client.rst Outdated Show resolved Hide resolved

haydenbaker reviewed

View reviewed changes

docs/source-2.0/java/client/dynamic-client.rst Show resolved Hide resolved

haydenbaker reviewed

View reviewed changes

docs/source-2.0/java/client/dynamic-client.rst Outdated Show resolved Hide resolved

haydenbaker reviewed

View reviewed changes

docs/source-2.0/java/client/dynamic-client.rst Show resolved Hide resolved

haydenbaker reviewed

View reviewed changes

docs/source-2.0/java/client/generating-clients.rst Outdated Show resolved Hide resolved

haydenbaker reviewed

View reviewed changes

docs/source-2.0/java/client/generating-clients.rst Outdated Show resolved Hide resolved

haydenbaker reviewed

View reviewed changes

docs/source-2.0/java/client/generating-clients.rst Outdated Show resolved Hide resolved

haydenbaker reviewed

View reviewed changes

docs/source-2.0/java/client/generating-clients.rst Outdated Show resolved Hide resolved

haydenbaker reviewed

View reviewed changes

docs/source-2.0/java/client/generating-clients.rst Outdated Show resolved Hide resolved

haydenbaker reviewed

View reviewed changes

docs/source-2.0/java/client/generating-clients.rst Outdated Show resolved Hide resolved

haydenbaker reviewed

View reviewed changes

docs/source-2.0/java/client/generating-clients.rst Outdated Show resolved Hide resolved

haydenbaker reviewed

View reviewed changes

docs/source-2.0/java/client/generating-clients.rst Outdated Show resolved Hide resolved

haydenbaker reviewed

View reviewed changes

docs/source-2.0/java/client/generating-clients.rst Outdated Show resolved Hide resolved

haydenbaker reviewed

View reviewed changes

docs/source-2.0/java/client/plugins.rst Outdated Show resolved Hide resolved

haydenbaker reviewed

View reviewed changes

docs/source-2.0/java/client/plugins.rst Outdated Show resolved Hide resolved

haydenbaker reviewed

View reviewed changes

docs/source-2.0/java/client/plugins.rst Outdated Show resolved Hide resolved

hpmellema and others added 4 commits

February 19, 2025 08:20


          Apply suggestions from code review

af5dabe

Co-authored-by: Hayden Baker <haydenbaker98@gmail.com>


          Apply suggestions from code review

9c95855

Co-authored-by: Hayden Baker <haydenbaker98@gmail.com>


          Apply suggestions from code review

091ca6d

Co-authored-by: Hayden Baker <haydenbaker98@gmail.com>


          Apply suggestions from code review

f6b76c8

Co-authored-by: Hayden Baker <haydenbaker98@gmail.com>

hpmellema commented

View reviewed changes

docs/source-2.0/java/client/dynamic-client.rst Show resolved Hide resolved

docs/source-2.0/java/client/plugins.rst Outdated Show resolved Hide resolved

docs/source-2.0/java/client/codegen-integrations.rst Outdated Show resolved Hide resolved

docs/source-2.0/java/client/configuration.rst Outdated Show resolved Hide resolved

docs/source-2.0/java/client/configuration.rst Outdated Show resolved Hide resolved

docs/source-2.0/java/client/configuration.rst Outdated Show resolved Hide resolved

docs/source-2.0/java/client/customization.rst Outdated Show resolved Hide resolved

docs/source-2.0/java/client/configuration.rst Outdated Show resolved Hide resolved

docs/source-2.0/java/client/configuration.rst Outdated Show resolved Hide resolved

docs/source-2.0/java/client/configuration.rst Outdated Show resolved Hide resolved

hpmellema and others added 3 commits

February 19, 2025 08:46


          Apply suggestions from code review

fab1a33


          Address PR feedback

34a560f


          Remove reference to exchanges

eae43e3

hpmellema requested review from haydenbaker and kstich

February 19, 2025 16:22

haydenbaker approved these changes

View reviewed changes

hpmellema dismissed kstich’s stale review

February 19, 2025 19:02

.

hpmellema merged commit 4307434 into smithy-lang:main

7 checks passed

hpmellema deleted the add-client-guide-java branch

February 19, 2025 19:02

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet